home *** CD-ROM | disk | FTP | other *** search
/ Teach Yourself VRML 2 in 21 Days / Teach Yourself VRML 2 in 21 Days.iso / mac / ISO9660 / 3rdparty / POLYTRAN / dos / PT_DOS.ZIP / DOC_1 / IMP_LW.1 < prev    next >
Encoding:
Text File  |  1996-06-13  |  8.6 KB  |  181 lines
  1. .so psroff.inc        # Include the macros needed for output to Postscript
  2. .TH Import-Lightwave
  3. .SH NAME
  4. imp_lightwave \- Lightwave geometry import filter
  5. .SH SYNOPSIS
  6. .PP
  7. This man page describes the options specific to the Lightwave geometry
  8. import converter.
  9. .PP
  10. .SH EXAMPLE CONVERSION SYNTAX
  11. .PP
  12. To convert a Lightwave file to Wavefront using the default parameters listed 
  13. in the setup.ini file:
  14. .IP
  15. pt -i lw -o wave filename.lw
  16. .PP
  17. To convert a Lightwave file to VRML and override some of the default options 
  18. in setup.ini:
  19. .IP
  20. pt -i lw -in-lw-print-stats = yes -o vrml filename.lw
  21. .PP
  22. .SH OVERVIEW
  23. .PP
  24. This geometry import converter reads in Lightwave binary object files (.lw) 
  25. and ASCII scene files (.scn). In addition to its core import capabilities,
  26. the converter can also reconstruct scene hierarchy using information gleamed 
  27. from the scene file and accurately create texture coordinates for the object
  28. data from the input texture projections. It is the second most complex
  29. import converter, next to that of the 3D Studio reader - it handles
  30. all Lightwave geometry attributes (including texture coordinates),
  31. all shading and texture mapping options, and the various Lightwave
  32. texture projection methods.
  33. .PP
  34. A nice feature of the converter is that it will use object instancing to
  35. reduce the size of the imported scene. For example, if the Lightwave scene
  36. file references a Lightwave object 10 times then the converter will only
  37. read in and store the basis geometry for the referenced object once. All
  38. other references to the file will create instances of the object (in
  39. other words, "virtual" objects); this is a benefit of the object/instancing
  40. capabilities of the converter's internal database.
  41. .PP
  42. Some of the features of the converter include:
  43. .PP
  44. .IP
  45. 1. Reading of all Lightwave supported polygon geometry,
  46. .IP
  47. 2. Ability to break apart each Lightwave object according to the materials assigned to 
  48. each polygon,
  49. .IP
  50. 3. Objects which are instanced one or more times within Lightwave (cloned) are likewise 
  51. instanced within NuGraf. Thus, much memory is saved since only one true copy 
  52. of the raw geometry is stored in memory for each of the instances.
  53. .IP
  54. 4. The object hierarchy within the original Lightwave file is recreated exactly within 
  55. NuGraf.
  56. .IP
  57. 5. All cameras and lights types are supported.
  58. .IP
  59. 6. Every surface (material) attribute is mapped to equivalent NuGraf surface attributes.
  60. .IP
  61. 7. All texture mapping types are supported (diffuse, specular, spherical environment 
  62. mapping, etc).
  63. .IP
  64. 8. All of the Lightwave texture projection methods are supported, including planar, 
  65. spherical, cylindrical and cubical. These projection methods are converted directly to 
  66. equivalent NuGraf projection methods. The conversion is exact, so the textures 
  67. should appear faithfully when rendered within NuGraf or when the data is exported to 
  68. another file format (such as 3D Studio, VRML or Wavefront).
  69. .IP
  70. 9. An IFF image format reader has been added to the NuGraf software so that it can 
  71. directly read in the Lightwave IFF-formatted texture maps.
  72. .PP
  73. As some background information, Lightwave uses two types of files to describe 
  74. a scene:
  75. .IP
  76. 1. The raw geometry for each object is stored in a separate file called a 
  77. Lightwave Object File. Normally it has a file extension of .lw, .lwb, .lwobj 
  78. or sometimes no extension at all. These files are binary and cannot be viewed 
  79. directly with a text editor.
  80. .IP
  81. 2. The scene setup description file is stored in a single file called a 
  82. Lightwave Scene File; it lists the Lightwave binary object files (see
  83. above) which are to be read into the scene. Normally it has a file extension 
  84. of .scene, .scn or it must use a descriptive filename such as 
  85. "Load Up The Entire Scene". This file is human readable and can be edited 
  86. with a normal text editor.
  87. .PP
  88. Due to the fact that many Lightwave scene files originated on the Amiga 
  89. you will have to perform some hand editing of the files before they can be 
  90. loaded. In particular you should perform the following changes to the files:
  91. .IP
  92. 1. Copy any "brushes" (or "textures" in NuGraf lingo) used by the Lightwave 
  93. scene to the NuGraf texture directory. The textures are probably in the IFF 
  94. file format (with extensions .IFF, .MAP or .COL) so you must first rename 
  95. the file extension to .IFF then use a paint program (such as Adobe PhotoShop) 
  96. to convert the texture files to TIFF format (which is expected by this converter).
  97. .IP
  98. 2. If not using Windows NT or Windows 95 then change the filenames of all Lightwave 
  99. files to have a maximum length of 8 characters.
  100. .IP
  101. 3. Change the file extension of the Lightwave scene file to .scn.
  102. .IP
  103. 4. Change the file extension of the Lightwave object files to .lw.
  104. .IP
  105. 5. Edit the main Lightwave scene with a text editor and modify the filepath and 
  106. filename after each occurrence of the "LoadObject" keyword. For example, the 
  107. original filepath may look something like "LoadObject HD1:Bottle/ExampleBottle". 
  108. This should be changed, for example, to "bottle.lw".
  109. .PP
  110. Once these changes have been made invoke the geometry converter and import
  111. the Lightwave scene file (.scn). If no scene file exists for the scene 
  112. then directly import each Lightwave object file (.lw) one-by-one.
  113. .PP
  114. .SH NOTES
  115. .IP
  116. 1. Texture files are expected to be in TIFF format by this converter although 
  117. you are free to edit the imported scene to use any other format for the textures.
  118. .IP
  119. 2. If an object has more than one surface applied to it then the converter will 
  120. explode the object into separate pieces, each with a single surface assigned to it.
  121. .IP
  122. 3. A valiant attempt is made to map Lightwave surface attributes to equivalent NuGraf 
  123. surface attributes but it will probably not be perfect due to the differences between the 
  124. two programs.
  125. .IP
  126. 4. Lightwave allows a different texture projection type to be assigned to each texture 
  127. applied to a surface (ie: spherical for the color texture, cylindrical for the bump texture). 
  128. NuGraf only allows one, so it chooses the first texture projection type assigned to the 
  129. surface.
  130. .IP
  131. 5. The "smoothing angle" specified with the '-in-lw-smoothing-angle' option
  132. will be overridden on an object-by-object basis if a surface definition has a 
  133. "smoothing angle" associated with it.
  134. .IP
  135. 6. "Detail" polygons are created as separate polygons. This might cause problems when 
  136. rendered with NuGraf.
  137. .PP
  138. .SH COMMAND LINE OPTIONS
  139. .PP
  140. The following options are specific to this import converter:
  141. .TP
  142. -i lw
  143. This is the optional command line option which specifies that the input data
  144. is in one of the Lightwave file formats. If not specified then the converter 
  145. will try to guess the input file's format from its file extension 
  146. (.lw, lwobj, .lws, etc) and then from the contents of its file. 
  147. .TP
  148. -in-lw-break-apart-by-surf-name = [ yes | no ]
  149. If set to 'yes' then each imported Lightwave object will be exploded into
  150. separate objects based on the surfaces currently assigned to the object.
  151. For example, if a single object has surfaces 'surf1', 'surf2' and 'surf3'
  152. assigned to it then the object will be exploded into 3 sub-objects with
  153. an appropriate name for each new object. If set to 'no' then the object
  154. will not be exploded. The default is 'yes'.
  155. .TP
  156. -in-lw-compute-normals = [ yes | no ]
  157. If set to 'yes' then new vertex normals will be computed for a polygon 
  158. if it does not have any vertex normals already. The smoothing criterion is 
  159. based on the angle between abutting polygons; common smoothed vertex normals 
  160. will be computed if the angle between their geometric surfaces normals is 
  161. less than the '-in-lw-smoothing-angle' angle described below. If set to
  162. 'no' then no new vertex normals will be created.
  163. .TP
  164. -in-lw-debug = [ yes | no ]
  165. If 'yes' then verbose parsing information will be output to the file ASCII
  166. 'debuglw.txt' located within the current working directory. The default 
  167. is 'no'.
  168. .TP
  169. -in-lw-smoothing-angle = #
  170. This option sets the cut-off smoothing angle (in degrees) used by the vertex normal
  171. computation algorithm. If the angle between two abutting polygons is greater
  172. than this number then no smoothing will occur (a crease will be evident
  173. between the two polygons), else smoothing will occur where the polygons
  174. meet. The default angle is 30 degrees. If a Lightwave object file (.lw)
  175. specifies a smoothing angle then that angle will override the angle
  176. specified in this option (but only for a specific object).
  177. .TP
  178. -in-lw-print-stats = [ yes | no ]
  179. If this option is set to 'yes' then the converter will report the 
  180. number of polygons and vertices read from the file.
  181.